.TH @UCPACKAGE@ 1 "November 2004" Linux "User Manuals"
.SH NAME
@PACKAGE@ \- monitor the progress of data through a pipe
.SH SYNOPSIS
.B @PACKAGE@
[\fIOPTION\fR]
[\fIFILE\fR]...
.br
.B @PACKAGE@
[\fI\-h\fR|\fI\-l\fR|\fI\-V\fR]


.SH DESCRIPTION
.B @PACKAGE@
allows a user to see the progress of data through a pipeline, by giving
information such as time elapsed, percentage completed (with progress bar),
current throughput rate, total data transferred, and ETA.

To use it, insert it in a pipeline between two processes, with the
appropriate options.  Its standard input will be passed through to its
standard output and progress will be shown on standard error.

.B @PACKAGE@
will copy each supplied
.B FILE
in turn to standard output
.BR "" "(" -
means standard input), or if no
.BR FILE s
are specified just standard input is copied. This is the same behaviour
as
.BR cat (1).

A simple example to watch how quickly a file is transferred using
.BR nc (1):

.RS
.B @PACKAGE@ file | nc -w 1 somewhere.com 3000
.RE

A similar example, transferring a file from another process and passing the
expected size to
.BR @PACKAGE@ :

.RS
.B cat file | @PACKAGE@ -s 12345 | nc -w 1 somewhere.com 3000
.RE

A more complicated example using numeric output to feed into the
.BR dialog (1)
program for a full-screen progress display:
 
.RS
.B (tar cf - . \e
.br
.B " | @PACKAGE@ -n -s `du -sb . | awk '{print $1}'` \e"
.br
.B " | gzip -9 > out.tgz) 2>&1 \e"
.br
.B | dialog --gauge 'Progress' 7 70
.RE

Frequent use of this third form is not recommended as it may cause the
programmer to overheat.


.SH OPTIONS
.B @PACKAGE@
takes many options, which are divided into display switches, output
modifiers, and general options.


.SH DISPLAY SWITCHES
If no display switches are specified,
.B @PACKAGE@
behaves as if
.BR \-p ", " \-t ", " \-e ", " \-r ", and " \-b
had been given (i.e. everything is switched on). Otherwise, only those
display types that are explicitly switched on will be shown.
.TP
.B \-p, \-\-progress
Turn the progress bar on.  If standard input is not a file and no
size was given (with the
.B \-s
modifier), the progress bar cannot indicate how close to completion the
transfer is, so it will just move left and right to indicate that data is
moving.
.TP
.B \-t, \-\-timer
Turn the timer on.  This will display the total elapsed time that
.B @PACKAGE@
has been running for.
.TP
.B \-e, \-\-eta
Turn the ETA timer on.  This will attempt to guess, based on previous
transfer rates and the total data size, how long it will be before
completion.  This option will have no effect if the total data size cannot
be determined.
.TP
.B \-r, \-\-rate
Turn the rate counter on.  This will display the current rate of data
transfer.
.TP
.B \-b, \-\-bytes
Turn the total byte counter on.  This will display the total amount of
data transferred so far.
.TP
.B \-n, \-\-numeric
Numeric output.  Instead of giving a visual indication of progress,
.B @PACKAGE@
will give an integer percentage, one per line, on standard error, suitable
for piping (via convoluted redirection) into
.BR dialog (1).
Note that
.B \-f
is not required if
.B \-n
is being used.
.TP
.B \-q, \-\-quiet
No output.  Useful if the
.B \-L
option is being used on its own to just limit the transfer rate of a pipe.


.SH OUTPUT MODIFIERS
.TP
.B \-L RATE, \-\-rate-limit RATE
Limit the transfer to a maximum of
.B RATE
bytes per second.  A suffix of "k", "m", "g", or "t" can be added to denote
kilobytes (*1024), megabytes, and so on.
.TP
.B \-W, \-\-wait
Wait until the first byte has been transferred before showing any progress
information or calculating any ETAs.  Useful if the program you are piping to
or from requires extra information before it starts, eg piping data into
.BR gpg (1)
or
.BR mcrypt (1)
which require a passphrase before data can be processed.
.TP
.B \-s SIZE, \-\-size SIZE
Assume the total amount of data to be transferred is
.B SIZE
bytes when calculating percentages and ETAs.  The same suffixes of "k", "m"
etc can be used as with
.BR -L .
.TP
.B \-i SEC, \-\-interval SEC
Wait
.B SEC
seconds between updates.  The default is to update every second.
Note that this can be a decimal such as 0.1.
.TP
.B \-w WIDTH, \-\-width WIDTH
Assume the terminal is
.B WIDTH
characters wide, instead of trying to work it out (or assuming 80 if it
cannot be guessed).
.TP
.B \-H HEIGHT, \-\-height HEIGHT
Assume the terminal is
.B HEIGHT
rows high, instead of trying to work it out (or assuming 25 if it
cannot be guessed).
.TP
.B \-N NAME, \-\-name NAME
Prefix the output information with
.BR NAME .
Useful in conjunction with
.B \-c
if you have a complicated pipeline and you want to be able to tell different
parts of it apart.
.TP
.B \-f, \-\-force
Force output.  Normally,
.B @PACKAGE@
will not output any visual display if standard error is not a terminal. 
This option forces it to do so.
.TP
.B \-c, \-\-cursor
Use cursor positioning escape sequences instead of just using carriage
returns.  This is useful in conjunction with
.B \-N
(name) if you are using multiple
.B @PACKAGE@
invocations in a single, long, pipeline.


.SH GENERAL OPTIONS
.TP
.B \-h, \-\-help
Print a usage message on standard output and exit successfully.
.TP
.B \-l, \-\-license
Print details of the program's license on standard output and exit
successfully.
.TP
.B \-V, \-\-version         
Print version information on standard output and exit successfully.


.SH AUTHORS
Andrew Wood <andrew.wood@ivarch.com>
.br
.I http://www.ivarch.com/

Cedric Delfosse <cedric@debian.org>
.br
(Debian package maintainer)

Eduardo Aguiar <eduardo.oliveira@sondabrasil.com.br>
.br
(provided Portuguese [Brazilian] translation)

Stephane Lacasse <tecknojunky@tecknojunky.com>
.br
(provided French translation)
.br
.I http://www.tecknojunky.com/

Marcos Kreinacke <m.kreinacke@nettec-systeme.net>
.br
(provided German translation)

Bartosz Fenski <fenio@o2.pl>
.br
(provided Polish translation, along with Krystian Zubel)
.br
.I http://skawina.eu.org/

Joshua Jensen
.br
(reported RPM installation bug)

Boris Folgmann
.br
(reported cursor handling bug)
.br
.I http://www.folgmann.com/en/

Mathias Gumz
.br
(reported NLS bug)


.SH BUGS
If you find any bugs, please contact the primary author, either by email or
by using the contact form on the web site.


.SH "SEE ALSO"
.BR cat (1),
.BR dialog (1)

The documentation for
.B @PACKAGE@
is also maintained as a Texinfo manual.  If the
.B info
and
.B @PACKAGE@
programs are properly installed at your site, the command
.IP
.B info @PACKAGE@
.PP
should give you access to the Texinfo manual.


.SH LICENSE
This is free software, distributed under the ARTISTIC license.
